Smart Readers

Table Name: GXT_READERUNITS_TBL

List

Request a list of smart readers.

  • Request:

    Copy 
    http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=List&SubType=GXT_READERUNITS_TBL

  • Response:

    Copy 
    1=Smart Reader 1&2=Smart Reader 2

Detail

Request the details of a specific smart reader.

  • Request:

    Copy 
    http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=Detail&SubType=GXT_READERUNITS_TBL&RecId=<RecId>

  • Response:

    Copy 
    ReaderUnitId=1&Name=Smart Reader 1&ExpanderAddress=0&ExpanderPort=0&ConfiguredAddress=0&ReaderOneType=2147483647&ReaderOneDoor=2147483647&ReaderOneArea=2147483647&ReaderOneKeypad=2147483647&ReaderOneElevator=2147483647&ReaderOneFormat=0&AllowReadingOpenedUnlocked=true&InputFunctionsEnabled=true&LED1FollowsLock1PGM=false&BondSenseInputEnabled=false&REXEnabled=true&RENEnabled=false&SendFormatErrors=true&IntelligentReaderTamperMode=false&DisarmAreaForDoorOnAccess=false&AllowAccessWhenAreaArmed=false&DisarmUsersAreaONValidCard=false&LogReaderEvents=false&SwapLockLEDDisplay=false&ActivateAccessLevelPGM=false&DisplayCardDetailWhenInvalid=true&ArmUsersArea=false&EnableBeamFunctionOnZone3=false&InvertDoorStateControlR1=false&InvertSenseStateControlR1=false&InvertREXInputR1=false&InvertRENInputR1=false&AlwaysAllowREX=true&RecycleDoorOpenTimeOnREX=false&ForcedDoorSendsDoorOpen1=false&DisableRedLEDProcessing1=false&DisableGreenLEDProcessing1=false&DisableBuzzerProcessing1=false&RecycleREXTime=false&UseProgrammedCardExpiry=false&ReaderOneLocation=1&ReaderOneMode=0&ReaderOneKeypadType=2&ReaderOneArmingMode=0&Reader1SecondaryFormat=0&Reader1FunctionPGM=2147483647&Reader1FunctionPGMGroup=2147483647&ProxReadingMode=2147483647&DESFireReadingMode=2147483647&MifareReadingMode=2147483647&Interface=2147483647&LEDFunction=2147483647&Backlight=2147483647&DefaultSector=2147483647&EncryptionKey1=&EncryptionKey2=&EncryptionKey3=&EncryptionKey4=&Commands=&LinkedRSDAddress=2147483647&CardDataAESEncryptionKey=&NonICTSectorProgrammed=false

Update

Update a specific smart reader.

  • Request:

    Copy 
    http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_READERUNITS_TBL&ReaderUnitId=1&Name=OSDP1

  • Response:

    Copy 
    OK

Create

Create a smart reader. To create a smart reader, use the same parameters as update but leave the ReaderUnitId empty.

  • Request:

    Copy 
    http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_READERUNITS_TBL&ReaderUnitId=&Name=Smart Reader 1&ExpanderAddress=0&ExpanderPort=0&ConfiguredAddress=0&ReaderOneType=2147483647&ReaderOneDoor=2147483647&ReaderOneArea=2147483647&ReaderOneKeypad=2147483647&ReaderOneElevator=2147483647&ReaderOneFormat=0&AllowReadingOpenedUnlocked=true&InputFunctionsEnabled=true&LED1FollowsLock1PGM=false&BondSenseInputEnabled=false&REXEnabled=true&RENEnabled=false&SendFormatErrors=true&IntelligentReaderTamperMode=false&DisarmAreaForDoorOnAccess=false&AllowAccessWhenAreaArmed=false&DisarmUsersAreaONValidCard=false&LogReaderEvents=false&SwapLockLEDDisplay=false&ActivateAccessLevelPGM=false&DisplayCardDetailWhenInvalid=true&ArmUsersArea=false&EnableBeamFunctionOnZone3=false&InvertDoorStateControlR1=false&InvertSenseStateControlR1=false&InvertREXInputR1=false&InvertRENInputR1=false&AlwaysAllowREX=true&RecycleDoorOpenTimeOnREX=false&ForcedDoorSendsDoorOpen1=false&DisableRedLEDProcessing1=false&DisableGreenLEDProcessing1=false&DisableBuzzerProcessing1=false&RecycleREXTime=false&UseProgrammedCardExpiry=false&ReaderOneLocation=1&ReaderOneMode=0&ReaderOneKeypadType=2&ReaderOneArmingMode=0&Reader1SecondaryFormat=0&Reader1FunctionPGM=2147483647&Reader1FunctionPGMGroup=2147483647&ProxReadingMode=2147483647&DESFireReadingMode=2147483647&MifareReadingMode=2147483647&Interface=2147483647&LEDFunction=2147483647&Backlight=2147483647&DefaultSector=2147483647&EncryptionKey1=&EncryptionKey2=&EncryptionKey3=&EncryptionKey4=&Commands=&LinkedRSDAddress=2147483647&CardDataAESEncryptionKey=&NonICTSectorProgrammed=false

  • Response:

    Copy 
    OK

When using the API to directly add records, please ensure the number of records added does not exceed the license limit for this record type, as this will result in undefined behavior. The license limit can be determined using the LicenseLimit request (see System).

Delete

Delete a specific smart reader.

  • Request:

    Copy 
    http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Delete&SubType=GXT_READERUNITS_TBL&RecId=<RecId>

  • Response:

    Copy 
    OK

Parameters

Parameter

Display Name

Default Value

Description

ReaderUnitId

Database ID

1

The Detail, Control and Delete APIs use this value as the RecId.

Name

Name

Smart Reader 1

 

ExpanderAddress

Expander Address

0

 

ExpanderPort

Expander Port

0

 

ConfiguredAddress

Configured Address

0

 

ReaderOneType

 

2147483647

 

ReaderOneDoor

Reader 1 Door

2147483647

 

ReaderOneArea

Reader 1 Area Control Area

2147483647

 

ReaderOneKeypad

Keypad to Use for PINs Reader 1

2147483647

The settings are:

Value

Setting

0

LCD Keypad

1

26 Bit (Site 0)

2

ARK-501

3

4 Bit

4

4 Bit Parity

5

4 Bit Buf

6

4 Bit Buf and Par

7

36 Bit IEI (Site 0)

8-14

Reserved

2147483647

None

ReaderOneElevator

Reader 1 Elevator

2147483647

 

ReaderOneFormat

Reader 1 Format

0

See Reader Formats for the available settings.

AllowReadingOpenedUnlocked

Allow Reading Opened/Unlocked

true

 

InputFunctionsEnabled

Door Sense Enabled

true

This option is not used.

LED1FollowsLock1PGM

 

false

This option is not used.

BondSenseInputEnabled

Bond Sense Input Enabled

false

This option is not used.

REXEnabled

REX Enabled

true

This option is not used.

RENEnabled

REN Enabled

false

This option is not used.

SendFormatErrors

Send Format Errors

true

 

IntelligentReaderTamperMode

Intelligent Reader Tamper Mode

false

This option is not used.

DisarmAreaForDoorOnAccess

Disarm Area For Door On Access

false

 

AllowAccessWhenAreaArmed

Allow Access When Area Armed

false

 

DisarmUsersAreaONValidCard

Disarm Users Area On Valid Card

false

 

LogReaderEvents

Log Reader Events

false

 

SwapLockLEDDisplay

Swap Lock LED Display

false

This is a legacy option that has no effect.

ActivateAccessLevelPGM

Activate Access Level Output

false

 

DisplayCardDetailWhenInvalid

Display Card Detail When Invalid

true

 

ArmUsersArea

 

false

This option is not used.

EnableBeamFunctionOnZone3

Enable Beam Function on Input 3

false

This option is not used.

InvertDoorStateControlR1

 

false

This option is not used.

InvertSenseStateControlR1

 

false

This option is not used.

InvertREXInputR1

 

false

This option is not used.

InvertRENInputR1

 

false

This option is not used.

AlwaysAllowREX

Always Allow REX

true

This option is not used.

RecycleDoorOpenTimeOnREX

 

false

This option is not used.

ForcedDoorSendsDoorOpen1

 

false

This option is not used.

DisableRedLEDProcessing1

 

false

This option is not used.

DisableGreenLEDProcessing1

 

false

This option is not used.

DisableBuzzerProcessing1

 

false

This option is not used.

RecycleREXTime

Recycle REX Time

false

This option is not used.

UseProgrammedCardExpiry

 

false

This option is not used.

ReaderOneLocation

Reader 1 Location

1

The settings are:

Value

Setting

0

Exit

1

Entry

ReaderOneMode

Reader 1 Mode

0

The settings are:

Value

Setting

0

Access

1

Elevator

2

Area Control

ReaderOneKeypadType

Reader 1 Keypad Type

2

The settings are:

Value

Setting

0

LCD Keypad

1

26 Bit (Site 0)

2

ARK-501

3

4 Bit

4

4 Bit Parity

5

4 Bit Buf

6

4 Bit Buf and Par

7

36 Bit IEI (Site 0)

8-14

Reserved

2147483647

None

ReaderOneArmingMode

Reader 1 Arming Mode

0

The settings are:

Value

Setting

0

Arm Area On 2 Reads

1

Read And Zone 4 Of Expander

2

Arm Area On 3 Reads

3

Toggle Function Output On 3 Reads

4

Activate Function Output On 3 Reads

2147483647

None

Reader1SecondaryFormat

Reader 1 Secondary Format

0

See Reader Formats for the available settings.

Reader1FunctionPGM

Reader 1 Function Output

2147483647

 

Reader1FunctionPGMGroup

Reader 1 Function Output Group

2147483647

 

ProxReadingMode

 

2147483647

This is a legacy option that has no effect.

DESFireReadingMode

 

2147483647

This is a legacy option that has no effect.

MifareReadingMode

 

2147483647

This is a legacy option that has no effect.

Interface

 

2147483647

This is a legacy option that has no effect.

LEDFunction

 

2147483647

This is a legacy option that has no effect.

Backlight

 

2147483647

This is a legacy option that has no effect.

DefaultSector

 

2147483647

This is a legacy option that has no effect.

EncryptionKey1

 

 

This is a legacy option that has no effect.

EncryptionKey2

 

 

This is a legacy option that has no effect.

EncryptionKey3

 

 

This is a legacy option that has no effect.

EncryptionKey4

 

 

This is a legacy option that has no effect.

Commands

Commands

 

 

LinkedRSDAddress

Linked RSD Address

2147483647

CardDataAESEncryptionKey

Card Data AES Encryption Key

 

 

NonICTSectorProgrammed

Read Non ICT Programmed Sector Data

false

 

CredentialType*

Reader Credential Match Types